home *** CD-ROM | disk | FTP | other *** search
/ Aminet 28 / Aminet 28 (1998)(GTI - Schatztruhe)[!][Dec 1998].iso / Aminet / dev / e / kyz_obj.lha / doc / rexxstate.doc < prev    next >
Text File  |  1998-10-18  |  7KB  |  300 lines
  1. TABLE OF CONTENTS
  2.  
  3. rexxstate.m/--overview--
  4. rexxstate.m/close_console
  5. rexxstate.m/console_open
  6. rexxstate.m/end
  7. rexxstate.m/halt
  8. rexxstate.m/new
  9. rexxstate.m/open_console
  10. rexxstate.m/resume
  11. rexxstate.m/running
  12. rexxstate.m/shutdown
  13. rexxstate.m/start
  14. rexxstate.m/suspend
  15. rexxstate.m/suspended
  16. rexxstate.m/trace_off
  17. rexxstate.m/trace_on
  18. rexxstate.m/tracing
  19. rexxstate.m/--overview--                             rexxstate.m/--overview--
  20.  
  21.    PURPOSE
  22.     To control the global aspects of the ARexx system.
  23.  
  24.    OVERVIEW
  25.     ARexx  is  an  interpreter program which has the ability to trace,
  26.     start,  pause,  and  cancel  the  ARexx scripts that it runs. This
  27.     object allows you to control these global ARexx processes:
  28.  
  29.     - whether ARexx is running or not (RexxMast / RXC)
  30.       running(), start(), shutdown()
  31.     - whether ARexx scripts are suspended or not
  32.       suspended(), suspend(), resume()
  33.     - whether the ARexx console is open or not (TCO/TCC)
  34.       console_open(), open_console(), close_console()
  35.     - whether ARexx is running in trace mode or not (TS/TE).
  36.       tracing(), trace_on(), trace_off()
  37.  
  38.     There  is  also  a method to immediately and irreversibly halt all
  39.     running ARexx programs, which simulates the HI command.
  40.  
  41.    NOTE
  42.     The  state  of  ARexx  is global, and this class respects that, it
  43.     shows  and sets this global ARexx state, it does not hold seperate
  44.     states  in  individual  instances of the class, so therefore using
  45.     more than one instance does not make sense, and is unneccessary.
  46.  
  47.     This class is based on the guts of commands in SYS:RexxC/
  48.  
  49.     Still todo is RXSET, RX is done by other/sendrexx.m and
  50.     WaitForPort / RXLIB aren't all that useful?!
  51.  
  52. rexxstate.m/close_console                           rexxstate.m/close_console
  53.  
  54.    NAME
  55.     rexxstate.close_console() -- close the ARexx trace console.
  56.  
  57.    SYNOPSIS
  58.     succeeded := close_console()
  59.  
  60.    FUNCTION
  61.     Shuts the ARexx trace and debugging console, like the TCC command.
  62.  
  63.    RESULT
  64.     succeeded - TRUE if the console is now shut, otherwise FALSE.
  65.  
  66.    SEE ALSO
  67.     console_open(), open_console()
  68.  
  69. rexxstate.m/console_open                             rexxstate.m/console_open
  70.  
  71.    NAME
  72.     rexxstate.console_open() -- check if ARexx trace console is open.
  73.  
  74.    SYNOPSIS
  75.     open := console_open()
  76.  
  77.    FUNCTION
  78.     Checks if the ARexx trace and debugging console is open or not.
  79.  
  80.    RESULT
  81.     open - TRUE if the console is open, otherwise FALSE.
  82.  
  83.    SEE ALSO
  84.     open_console(), close_console()
  85.  
  86. rexxstate.m/end                                               rexxstate.m/end
  87.  
  88.    NAME
  89.     rexxstate.end() -- Destructor.
  90.  
  91.    SYNOPSIS
  92.     end()
  93.  
  94.    FUNCTION
  95.     Closes resources used by an instance of the rexxstate class.
  96.  
  97.    SEE ALSO
  98.     new()
  99.  
  100. rexxstate.m/halt                                             rexxstate.m/halt
  101.  
  102.    NAME
  103.     rexxstate.halt() -- end all currently running ARexx programs.
  104.  
  105.    SYNOPSIS
  106.     halt()
  107.  
  108.    FUNCTION
  109.     Halts  all  currently  running  ARexx programs and ends them. When
  110.     this returns, all programs are most likely to be in the process of
  111.     ending. This does not shut down ARexx.
  112.  
  113. rexxstate.m/new                                               rexxstate.m/new
  114.  
  115.    NAME
  116.     rexxstate.new() -- Constructor.
  117.  
  118.    SYNOPSIS
  119.     new()
  120.  
  121.    FUNCTION
  122.     Initialises an instance of the rexxstate class. Raises "LIB" if it
  123.     cannot open 'rexxsyslib.library' version 33 or better.
  124.  
  125.    SEE ALSO
  126.     end()
  127.  
  128. rexxstate.m/open_console                             rexxstate.m/open_console
  129.  
  130.    NAME
  131.     rexxstate.open_console() -- open the ARexx trace console.
  132.  
  133.    SYNOPSIS
  134.     succeeded := open_console()
  135.  
  136.    FUNCTION
  137.     Opens the ARexx trace and debugging console, like the TCO command.
  138.  
  139.    RESULT
  140.     succeeded - TRUE if the console is now open, otherwise FALSE.
  141.  
  142.    SEE ALSO
  143.     console_open(), close_console()
  144.  
  145. rexxstate.m/resume                                         rexxstate.m/resume
  146.  
  147.    NAME
  148.     rexxstate.resume() -- resume running ARexx programs.
  149.  
  150.    SYNOPSIS
  151.     success := resume()
  152.  
  153.    FUNCTION
  154.     Lets ARexx program execution continue.
  155.  
  156.    RESULT
  157.     success - TRUE if ARexx programs are now running, otherwise FALSE.
  158.  
  159.    SEE ALSO
  160.     suspended(), suspend()
  161.  
  162. rexxstate.m/running                                       rexxstate.m/running
  163.  
  164.    NAME
  165.     rexxstate.running() -- test if ARexx is running.
  166.  
  167.    SYNOPSIS
  168.     running := running()
  169.  
  170.    FUNCTION
  171.     Determines whether ARexx is running or not.
  172.  
  173.    RESULT
  174.     running - TRUE if RexxMast is running, FALSE otherwise.
  175.  
  176.    SEE ALSO
  177.     start(), shutdown()
  178.  
  179. rexxstate.m/shutdown                                     rexxstate.m/shutdown
  180.  
  181.    NAME
  182.     rexxstate.shutdown() -- shut down ARexx.
  183.  
  184.    SYNOPSIS
  185.     succeeded := shutdown()
  186.  
  187.    FUNCTION
  188.     Shuts down ARexx.
  189.  
  190.    RESULT
  191.     succeeded - TRUE if ARexx stops running, FALSE otherwise.
  192.  
  193.    SEE ALSO
  194.     start(), running()
  195.  
  196. rexxstate.m/start                                           rexxstate.m/start
  197.  
  198.    NAME
  199.     rexxstate.start() -- start up ARexx.
  200.  
  201.    SYNOPSIS
  202.     succeeded := start()
  203.  
  204.    FUNCTION
  205.     Starts up the RexxMast program, which starts the ARexx system.
  206.  
  207.    RESULT
  208.     succeeded - TRUE if RexxMast is now running, FALSE otherwise.
  209.  
  210.    SEE ALSO
  211.     shutdown(), running()
  212.  
  213. rexxstate.m/suspend                                       rexxstate.m/suspend
  214.  
  215.    NAME
  216.     rexxstate.suspend() -- suspend the running of ARexx programs.
  217.  
  218.    SYNOPSIS
  219.     success := suspend()
  220.  
  221.    FUNCTION
  222.     Puts all running ARexx programs on hold.
  223.  
  224.    RESULT
  225.     success - TRUE if ARexx programs are now suspended, otherwise FALSE.
  226.  
  227.    SEE ALSO
  228.     suspended(), resume()
  229.  
  230. rexxstate.m/suspended                                   rexxstate.m/suspended
  231.  
  232.    NAME
  233.     rexxstate.suspended() -- check if ARexx programs are suspended.
  234.  
  235.    SYNOPSIS
  236.     suspended := suspended()
  237.  
  238.    FUNCTION
  239.     Checks if ARexx is currently running its programs or not.
  240.  
  241.    RESULT
  242.     suspended - TRUE if ARexx is suspending programs, otherwise FALSE.
  243.  
  244.    SEE ALSO
  245.     suspend(), resume()
  246.  
  247. rexxstate.m/trace_off                                   rexxstate.m/trace_off
  248.  
  249.    NAME
  250.     rexxstate.trace_off() -- turn ARexx trace mode off.
  251.  
  252.    SYNOPSIS
  253.     success := trace_off()
  254.  
  255.    FUNCTION
  256.     Turns ARexx trace mode off.
  257.  
  258.    RESULT
  259.     success - TRUE if ARexx is now out of trace mode, otherwise FALSE.
  260.  
  261.    SEE ALSO
  262.     tracing(), trace_on()
  263.  
  264. rexxstate.m/trace_on                                     rexxstate.m/trace_on
  265.  
  266.    NAME
  267.     rexxstate.trace_on() -- turn ARexx trace mode on.
  268.  
  269.    SYNOPSIS
  270.     success := trace_on()
  271.  
  272.    FUNCTION
  273.     Turns  ARexx  trace  mode  on.  Program execution flow will now be
  274.     listed  to  the  trace  console (if it is open) or to the standard
  275.     output of the programs in question.
  276.  
  277.    RESULT
  278.     success - TRUE if ARexx is now in trace mode, otherwise FALSE.
  279.  
  280.    SEE ALSO
  281.     tracing(), trace_off()
  282.  
  283. rexxstate.m/tracing                                       rexxstate.m/tracing
  284.  
  285.    NAME
  286.     rexxstate.tracing() -- check if ARexx trace mode is on.
  287.  
  288.    SYNOPSIS
  289.     tracing := tracing()
  290.  
  291.    FUNCTION
  292.     Checks if ARexx is in trace mode or not.
  293.  
  294.    RESULT
  295.     tracing - TRUE if ARexx is in trace mode, otherwise FALSE.
  296.  
  297.    SEE ALSO
  298.     trace_on(), trace_off()
  299.  
  300.